home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 007 / a86v311c.arc / 10RELOC.DOC < prev    next >
Text File  |  1987-11-24  |  33KB  |  661 lines

  1. CHAPTER 10   RELOCATION AND LINKAGE                       10-1
  2.  
  3.  
  4. A86 allows you to produce either .COM files, which can be run
  5. immediately as standalone programs, or .OBJ files, to be fed to
  6. the MS-DOS LINK program.  In this chapter I'll discuss .OBJ mode
  7. of A86.
  8.  
  9.  
  10. .OBJ Production Made Easy
  11.  
  12. I'll start by giving you the minimum amount of information you
  13. need to know to produce .OBJ files.  If you are writing short
  14. interface routines, and do not want to concern yourself with the
  15. esoterica of OBJ files (segments, groups, publics, etc.), you can
  16. survive quite nicely by reading only this section.
  17.  
  18. There are two ways you can cause A86 to produce a .OBJ file as
  19. its object output.  One way is to explicitly give .OBJ as the
  20. output file name: for example, you can assemble the source file
  21. FOO.8 by giving the command "A86 FOO.8 FOO.OBJ".  The other way
  22. is to specify the switch +O (letter O not digit 0).  This is
  23. illustrated by the invocation "A86 +O FOO.8", which will have the
  24. same effect as the first invocation.
  25.  
  26. My design philosophy for .OBJ production is to accommodate two
  27. types of user.  The first type of user is writing new code, to
  28. link to other (usually high-level language) modules.  That person
  29. should be able to write the module with a minimum of red tape,
  30. and have A86 do the right thing.  The second type of user has
  31. existing modules written for Intel/IBM assemblers, and wants to
  32. port them to A86.  A86 should recognize and act upon all the
  33. relocation directives (SEGMENT, GROUP, PUBLIC, EXTRN, NAME, END)
  34. given.  The assembly should work even if several files, assembled
  35. separately under the Intel/IBM assembler, are fed to a single A86
  36. assembly.  You'll see if you read on through this entire chapter
  37. that the multiple-files requirement causes A86 to interpret some
  38. of the relocation directives a little differently (while
  39. achieving compatible results).
  40.  
  41. Let's suppose you're writing new code: for example, an interface
  42. routine to the "C" language, that multiplies a 16-bit number by
  43. 10.  "C" pushes the input number onto the stack, before calling
  44. your routine.  Your code needs to get the number, multiply it by
  45. 10, and return the answer in the AX register.  You can code it:
  46.  
  47. _MUL10:          ; "C" expects all public names to start with "_"
  48.   PUSH BP        ; "C" expects BP to be preserved
  49.   MOV BP,SP      ; we use BP to address the stack
  50.   MOV AX,[BP+4]  ; fetch the number N, beyond BP and the ret addr
  51.   ADD AX,AX      ; 2N
  52.   MOV BX,AX      ; 2N is saved in BX
  53.   ADD AX,AX      ; 4N
  54.   ADD AX,AX      ; 8N
  55.   ADD AX,BX      ; 8N + 2N = 10N
  56.   POP BP         ; BP is restored
  57.   RET            ; go back to caller
  58.                                                           10-2
  59. These 11 lines can be your entire source file!  If you name the
  60. file MUL10.8, A86 will create an object file MUL10.OBJ, that
  61. conforms to the standard SMALL model of computation for high-
  62. level languages.  If you use RETF instead of RET (thus, by the
  63. way, getting the operand from BP+6 instead of BP+4), the object
  64. module will conform to the standard LARGE model of computation.
  65. All the red-tape information required by the high-level language
  66. is provided implicitly by A86.  I'll go through this information
  67. in detail later, but you should need to read about it only if
  68. you're curious.
  69.  
  70. What happens if you need to access symbols outside the module
  71. you're assembling?  If the type of the symbol is correctly
  72. guessed from the instruction that refers to it, then you can
  73. simply refer to it, and leave it undefined within the module.
  74. For example, if A86 sees the instruction CALL PRINT with PRINT
  75. undefined, it will assume that PRINT is a NEAR procedure.  If
  76. PRINT is never defined within the module, A86 will act as if you
  77. declared PRINT via the directive EXTRN PRINT:NEAR.  The address
  78. of PRINT will be plugged into your instruction by LINK when it
  79. combines A86's .OBJ file with the high-level language's .OBJ
  80. files, to make the final program.
  81.  
  82. In general, the undefined operand to any CALL or JMP instruction
  83. is assumed to be NEAR.  The second (source) operand to a MOV or
  84. arithmetic instruction is assumed to be ABS (i.e., an immediate
  85. constant).  An undefined first (destination) operand is assumed
  86. to be a simple memory variable, of the same size (BYTE or WORD)
  87. as the register given in the second operand.  If your external
  88. symbol does not comply with these guidelines, you need to declare
  89. it with an EXTRN before you use it.  (You can also use EXTRN to
  90. declare types of non-complying forward-references within your
  91. module, as you'll see later.)
  92.  
  93. At this point, if you're a casual user, I think you've read
  94. enough to get going!  Read further only if you wish; or if you
  95. get stuck, and need to master the esoterica.
  96.  
  97.  
  98. Overview of Relocation and Linkage
  99.  
  100. When you assemble a program directly into a .COM file, the
  101. program has just two forms: the source program, that you can
  102. understand, and the .COM file, that the computer can "understand"
  103. (i.e., execute).  A .OBJ file is an intermediate format: neither
  104. you nor the (executing) computer can make sense out a .OBJ file;
  105. only programs like LINK interpret .OBJ files.  The purpose of a
  106. .OBJ file is to allow you to assemble or compile just a part of a
  107. program.  The other parts (also in the form of .OBJ files) can be
  108. produced at a different time; often by a different assembler or
  109. compiler, whose source files are in a different language.  It's
  110. easy to see where the word "linkage" comes from: the LINK program
  111. puts the pieces of a program together.  The "relocation" comes
  112. because the assembler or compiler that makes a given program
  113. piece doesn't know how many other pieces will come before it, or
  114. how big the other pieces will be.  Each piece is constructed as
  115. if it started at location 0 within the program; then LINK
  116. "relocates" the piece to its true location.
  117.                                                           10-3
  118. Many of the relocation features of 86 assembly language are
  119. couched in terms of LINK's point of view, so we must look at the
  120. way LINK sees things.  LINK calls a .OBJ file an "object module",
  121. or just "module".  Each module has a NAME, that can be referred
  122. to when LINK issues diagnostic messages, such as error messages
  123. and symbol maps.  If a program symbol is used only within a
  124. single module, it does not need to be given to LINK, except
  125. possibly to pass along to a symbolic debugger.  On the other
  126. hand, if a program symbol is defined in one module and referenced
  127. in other modules, then LINK needs to know the name of the symbol,
  128. so it can resolve the references.  Such a symbol is PUBLIC in the
  129. module in which it is defined; it is "external" in the other
  130. modules, containing references to it.  Finally, exactly one
  131. module in a program must contain the starting location for the
  132. program; that module is called the "main module", and it must
  133. supply the starting address (which is not necessarily at the
  134. beginning of the module).
  135.  
  136. In the 86 family of microprocessors, the LINK system also does
  137. much to manage the memory segments that a program will fit into,
  138. and get its data from.  The (grotesquely ornate) level of support
  139. for segmentation was dictated by Intel when it specified (and IBM
  140. and the compiler-makers accepted) the format that .OBJ files will
  141. have.  I attended the fateful meeting at Intel, in which the
  142. crucial design decisions were made.  I regret to say that I sat
  143. quietly, while engineers more senior than I applied their fertile
  144. imaginations to construct fanciful scenarios which they felt had
  145. to be supported by LINK.  Let's now review the resulting
  146. segmentation model.
  147.  
  148. The parts of a program, as viewed by LINK, come in three
  149. different sizes: they can be (1) pieces of a single segment, (2)
  150. an entire single segment, or (3) a sequence of consecutive
  151. segments in 86 memory.  Size (1) should have been called
  152. something like FRAGMENT, but is instead called SEGMENT.  Size (2)
  153. should have been called SEGMENT, but is instead called GROUP.
  154. Size (3) should have been called "group", but is instead called
  155. "class".  Let me cling to the sensible terminology for one more
  156. paragraph, while I describe the worst scenario Intel wanted to
  157. support; then when I discuss individual directives, I'll
  158. regretfully revert to the official terminology.
  159.                                                           10-4
  160. The scenario is as follows: suppose you have a program that
  161. occupies about 100K bytes of memory.  The program contains a core
  162. of 20K bytes of utility routines that every part of the program
  163. calls.  You'd like every part of the program to be able to call
  164. these routines, using the NEAR form to save memory.  By gum, you
  165. can do it!  You simply(!) slice the program into three fragments:
  166. the utility routines will go into fragment U, and the rest of the
  167. program will be split into equal-sized 40K-byte fragments A and
  168. B.  Now you arrange the fragments in 8086 memory in the order
  169. A,U,B.  The fragments A and U form a 60K-byte block, addressed by
  170. a segment-register value G1, that points to the beginning of A.
  171. The fragments U and B form another 60K-byte block addressed by a
  172. segment-register value G2, that points to the beginning of U.  If
  173. you set the CS register to G1 when A is executing, and G2 when B
  174. is executing, the U fragment is accessible at all times.  Since
  175. all direct JMPs and CALLs are encoded as relative offsets, the U-
  176. code will execute direct jumps correctly whether addressed by G1
  177. with a huge offset, or G2 with a small offset.  Of course, if U
  178. contains any absolute pointers referring to itself (such as an
  179. indirect near JMP or CALL), you're in trouble.
  180.  
  181. It's now been nine years since the fateful design meeting took
  182. place, and I can report that the above scenario has never taken
  183. place in the real world.  And I can state with some authority
  184. that it never will.  The reason is that the only programs that
  185. exceed 64K bytes in size are coded in high-level language, not
  186. assembly language.  High-level language compilers follow a very,
  187. very restricted segmentation model-- no existing model comes
  188. remotely close to supporting the scheme suggested by the
  189. scenario.  But the 86 assembly language can support it-- the
  190. directives "G1 GROUP A,U" and "G2 GROUP B,U", followed by chunks
  191. of code of the appropriate object size, headed by directives "A
  192. SEGMENT", "B SEGMENT", and "U SEGMENT".  The LINK program is
  193. supposed to sort things out according to the scenario; but I
  194. can't say (and I have my doubts) if it actually succeeds in doing
  195. so.
  196.  
  197. The concept of "class" was added as an afterthought, to implement
  198. the more sensible and usable features that outsiders thought
  199. GROUPs were implementing;  namely, the ability to specify that
  200. different (and disjoint!) segments occur consecutively in memory.
  201. This allows programs to be arranged in a consistent manner-- for
  202. example, with all program code followed by all static data
  203. segments followed by all dynamically-allocated memory.
  204.                                                           10-5
  205. The NAME Directive
  206.  
  207. Syntax:   NAME module_name
  208.  
  209. The NAME directive specifies that "module_name" be given to LINK
  210. as the name of the module produced by this assembly.  The symbol
  211. "module_name" can be used elsewhere in your program without
  212. conflict: it can even, if you like, be a built-in assembler
  213. mnemonic (e.g. "NAME MOV" is acceptable)!
  214.  
  215. If you do not provide a NAME directive, A86 will use the name of
  216. the output object file, without the .OBJ extension.   If you
  217. provide more than one NAME directive, A86 will use the last one
  218. given, with no error reported.
  219.  
  220.  
  221.  
  222. The PUBLIC Directive
  223.  
  224. Syntax:   PUBLIC  sym1, sym2, sym3, ...
  225.           PUBLIC
  226.  
  227. The PUBLIC directive allows you to explicitly list the symbols
  228. defined in this assembly, that can be used by other modules.  If
  229. you do not give any PUBLIC directives in your program, A86 will
  230. use every relocatable label and variable name in your program,
  231. except local labels (the redefinable labels consisting of a
  232. letter followed by digits: L7, M1, Q234, etc.).  Symbols EQUated
  233. to constants, and symbols defined within structures and DATA
  234. SEGMENTs, are not implicitly declared PUBLIC: you have to
  235. explicitly include them in a PUBLIC directive.
  236.  
  237. A86 maintains an internal flag, telling it whether to figure out
  238. for itself which symbols are PUBLIC, or to let the program
  239. explicitly declare them.  The flag starts out "implicit", and is
  240. set to "explicit" only if A86 sees a PUBLIC directive with no
  241. names at all, or a PUBLIC directive containing at least one name
  242. that would have been implicitly made PUBLIC.
  243.  
  244. If you are writing new code, you'll probably want to keep the
  245. flag "implicit".  You use the PUBLIC directive only for those
  246. symbols which have the form of local labels, but aren't (e.g., a
  247. memory variable I1987 for 1987 income); and for absolute values
  248. that are globally accessed -- e.g. specify "PUBLIC
  249. OPEN_FILES_LIMIT" for a symbol defined as "OPEN_FILES_LIMIT EQU
  250. 20".
  251.  
  252. If you are porting existing code, that code will already have
  253. PUBLIC directives in it, and A86 will go to "explicit" mode,
  254. duplicating the functionality of other assemblers.
  255.  
  256. The PUBLIC directive with no names is used to force "explicit"
  257. mode, thus causing (if there are no further PUBLICs with names)
  258. the .OBJ file to declare no symbols PUBLIC.
  259.                                                           10-6
  260. There is another side effect to the PUBLIC directive: if a symbol
  261. is declared PUBLIC in a module, it had better be defined in that
  262. module.  If it isn't then A86 includes it in the .ERR listing of
  263. undefined symbols in the module, and suppresses output of the
  264. object file.
  265.  
  266.  
  267. The EXTRN Directive
  268.  
  269. Syntax:  EXTRN  sym1:type, sym2:type, ...
  270.  
  271.      where "type" is one of:  BYTE WORD DWORD QWORD TBYTE FAR
  272.             or synonymously:  B    W    D     Q     T     F
  273.                          or:  NEAR  ABS
  274.  
  275. The EXTRN directive allows you to attach a type to a symbol that
  276. may not yet be defined (and may never be defined) within your
  277. program.  This is often necessary for the assembler to generate
  278. the correct instruction form when the symbol is used as an
  279. operand.  All the possible types except ABS are defined elsewhere
  280. in the A86 language, but I list them again here for convenience:
  281.  
  282.    B or BYTE:  byte-sized memory variable
  283.    W or WORD:  word (2 byte) sized memory variable
  284.    D or DWORD: doubleword (4-byte) sized memory variable
  285.    Q or QWORD: quadword (8-byte) sized memory variable
  286.    T or TWORD: 10-byte-sized memory variable
  287.    NEAR:       program label accessed within a segment
  288.    FAR:        program label accessed from outside this segment
  289.    ABS:        an absolute number (i.e., an immediate constant)
  290.  
  291. An example of EXTRN usage is as follows: suppose there is a word
  292. memory variable IFARK in your program.  The variable might be
  293. declared at the end of the program; or it might be defined in a
  294. module completely outside of this program.  Without an EXTRN
  295. directive, A86 will assemble an instruction such as "MOV
  296. AX,IFARK" as the loading of an immediate constant IFARK into the
  297. AX register.  If you place the directive "EXTRN IFARK:W" at the
  298. top of your program, you'll get the correct instruction form for
  299. MOV AX,IFARK-- moving a word memory variable into the AX
  300. register.
  301.  
  302. A86 will allow more than one EXTRN directive for a given symbol,
  303. as long as the same type is given every time.  A86 will even
  304. allow an EXTRN directive for a symbol that has already been
  305. defined, as long as the type declared is consistent with the
  306. symbol's definition.  These allowances exist so that you can
  307. assemble multiple files written for another assembler, that had
  308. been fed separately to that assembler.
  309.                                                           10-7
  310. Note that EXTRN is viewed by A86 quite differently by A86 than by
  311. other assemblers.  In fact, if it weren't for those other
  312. assemblers, I'd use the mnemonic DECLARE instead of EXTRN.  A86
  313. doesn't really use EXTRN to determine which symbols are external-
  314. - it uses those symbols that are undefined at the end of
  315. assembly.  As I stated earlier in the chapter, an undefined
  316. symbol can be referenced without being declared via EXTRN.
  317. Conversely, a defined symbol can be declared (and redeclared) via
  318. EXTRN; being defined, such a symbol will not be specified
  319. "external" in the .OBJ file.
  320.  
  321. Because EXTRN is useful in forward-reference situations, it is
  322. now recognized even when A86 is assembling a .COM file.
  323.  
  324. For those of you who are accustomed to the more traditional use
  325. of EXTRN, and who do not like external records to be created
  326. "behind your back", A86 offers the "+x" option.  If you include
  327. "+x" in the program invocation, A86 will require that all
  328. undefined symbols be explicitly declared via an EXTRN.  Any
  329. undefined, undeclared symbols will be included in the .ERR
  330. listing of undefined symbols, and object file output will be
  331. suppressed.
  332.  
  333.  
  334. MAIN: The Starting Location for a Program
  335.  
  336. I've already stated that exactly one module in a program is the
  337. "main" module, containing the starting address of the entire
  338. program.  In A86 when assembling .OBJ files, the starting address
  339. is given by the label MAIN.  You simply provide the label "MAIN:"
  340. where you want the program to start.  The module containing MAIN
  341. is the main module.
  342.  
  343.  
  344. The END Directive
  345.  
  346. Syntax:  END
  347.          END start_addr
  348.  
  349. The END directive is used by other assemblers for two purposes,
  350. both of which are now a little silly.  The first purpose is to
  351. signal the end of assembly.  This was necessary back in the days
  352. when source files were input on media such as paper tape: you had
  353. to tell the assembler explicitly that the contents of the tape
  354. has ended.  Today the operating system can tell you when you've
  355. reached the end of the file, so this function is an anachronism.
  356.  
  357. The second purpose of END is, nonsensically, to allow you to
  358. specify the starting location of the program.  I suppose the
  359. person who wrote the first assembler back in the 1950's was too
  360. short on memory to implement a separate START directive, or a
  361. MAIN label like A86 has, and decided to let END do double-duty.
  362. I've always considered the example "END START" to have an Alice-
  363. in-Wonderland quality; it is fuel for the high-level-language
  364. snobs who like to attack assembly language.  Please defeat the
  365. snobs, and use "MAIN:" if you are writing new code.
  366.                                                           10-8
  367. For compatibility, A86 treats "END start_addr" exactly the same as
  368. if you had coded "MAIN EQU start_addr".  Note that if you want
  369. your program to assemble under both A86 and that other assembler,
  370. you can specify "END MAIN"-- A86 treats MAIN EQU MAIN as a legal
  371. redefinition of the symbol MAIN.
  372.  
  373. A86 ignores END when there is no starting-address operand, thus
  374. allowing assembly of multiple files written for other assemblers.
  375.  
  376.  
  377. The SEGMENT Directive
  378.  
  379. Syntax:  seg_name SEGMENT [align] [combine] ['class_name']
  380.  
  381. where "align" is one of:  BYTE   WORD   PARA   PAGE
  382.     "combine" is one of:  PUBLIC  STACK  COMMON  MEMORY  AT number
  383.  
  384. The SEGMENT directive says that assembled object code will
  385. henceforth go to a block of code whose name is "seg_name".
  386. "seg_name" is a symbol that represents a value that can be loaded
  387. into a segment register.  If "seg_name" is not declared in a
  388. GROUP directive, then its value should in fact be loaded into a
  389. segment register, in order to address the code.  If "seg_name" is
  390. declared in a GROUP directive, then the code is a a part of the
  391. segment addressed by the name of the group.
  392.  
  393. A program can consist of any number of named segments, to be
  394. combined in numerous exotic ways to produce the final program.
  395. You can redirect your object output from one segment to another
  396. in your assembly, by providing a SEGMENT directive before each
  397. piece of code.  You can even return to a segment you started
  398. earlier, by repeating a SEGMENT with the same name-- the
  399. assembler just picks up where it left off, subject to some
  400. possible skipping for memory-alignment, that I'll describe
  401. shortly.
  402.  
  403. The specifications following the word SEGMENT help to describe
  404. how the code in this module's part of the segment will be
  405. combined with code for the same segment name given in other
  406. modules; and also how this named segment will be grouped with
  407. other named segments.  Other assemblers require the
  408. specifications to be given in the order indicated.  A86 will
  409. accept any order, and will accept commas between the
  410. specifications if you want to provide them.  The only restriction
  411. is that "AT number" must be followed by a comma if it is not the
  412. last specification on the line.
  413.  
  414. The "align" specification tells if each piece of code within the
  415. segment should be aligned so that its starting address is an even
  416. multiple of some number.  BYTE alignment means there is no
  417. requirement; WORD alignment requires each piece to start at a
  418.                                                           10-9
  419. multiple of 2; PARA alignment, at a multiple of 16; PAGE
  420. alignment, at a multiple of 256.  For example, suppose you have a
  421. segment containing memory variables.  You can declare the segment
  422. with the statement "VAR_DATA SEGMENT WORD", which insures that
  423. the segment is aligned to an even memory address.  That way you
  424. can insure that all 16-bit and bigger memory quantities in the
  425. segment are aligned to even addresses, for faster access on the
  426. 16-bit machines of the 86 family.
  427.  
  428. There are special rules governing alignment for multiple pieces
  429. of the same named segment within the same program module.  Other
  430. assemblers outlaw conflicting alignment specifications in this
  431. situation; A86 accepts them, and uses the strictest specification
  432. given.  Furthermore, the alignment given for any specification
  433. beyond the first will control the alignment for that piece of
  434. code within this module's chunk.  For example, if a program
  435. contains two pieces of code headed by "VAR_DATA SEGMENT WORD",
  436. A86 will insert a byte between the pieces if the first piece has
  437. an odd number of bytes.  This insures correct assembly for
  438. multiple files written for another assembler.
  439.  
  440. If no "align" type is given for any of the pieces of a named
  441. segment, an alignment of PARA is assumed.
  442.  
  443.  
  444. The "combine" specification tells how the chunk of code from this
  445. module will be combined with the chunks of the same named
  446. segment, that come from other modules.  Yes, I know, that sounds
  447. like what "align" does; but "combine" takes a different, more
  448. major point of view:
  449.  
  450. * PUBLIC is the kind of combination we've been talking about all
  451.   along: each piece of the segment is located off the end of the
  452.   previously linked piece, subject to possible gaps for
  453.   alignment.  The size of the segment is the sum of the sizes of
  454.   the pieces, plus the sizes of the gaps.
  455.  
  456. * STACK is a combination-type reserved for the system's stack
  457.   segment.  To illustrate how STACK segment chunks are combined,
  458.   let's describe the only way a stack segment should ever be
  459.   used.  We'll call the segment PROG_STACK; and we declare it as
  460.   follows:
  461.  
  462.     PROG_STACK SEGMENT WORD STACK
  463.        DW 100 DUP (?)
  464.     TOP_OF_STACK:
  465.  
  466.   The code just given declares a stack area of 200 bytes (100
  467.   words) for this module.  If identical code occurs in each of
  468.   three modules which are then linked together, the resulting
  469.   PROG_STACK segment will have 600 bytes (the sizes are added),
  470.   but TOP_OF_STACK will be the same address (600) for each module
  471.   (each piece is overlayed at the top of the segment).  That way,
  472.   every module can declare and access the top of the stack, which
  473.   is the only static part of the stack that any code should ever
  474.   refer to.
  475.                                                           10-10
  476.  
  477. * COMMON is a type of memory area supported by FORTRAN.  Each
  478.   module's chunk of a COMMON segment starts at location 0, and
  479.   overlaps (usually duplicates) the pieces from all the other
  480.   modules.  The size of a COMMON segment is the size of the
  481.   largest chunk.
  482.  
  483. * MEMORY is supposed to be another kind of COMMON segment, that
  484.   is distinguished by automatically being located beyond all
  485.   other segments in memory.  The MS_DOS LINK program, however,
  486.   does not implement MEMORY segments, and instead treats them
  487.   identically to PUBLIC (not COMMON!) segments.  I can see no
  488.   useful purpose to the MEMORY combine-type, since the
  489.   functionality can be achieved by putting a COMMON segment into
  490.   a 'class' by itself, that goes above all the other classes.  So
  491.   don't use MEMORY.
  492.  
  493.   Sorry, I don't support the assembly of multiple files written
  494.   for other assemblers, that contain STACK, COMMON, or MEMORY
  495.   segments.  If I did, I would have to detect the file breaks,
  496.   and duplicate the overlapping functionality of these segment
  497.   types.  Since I don't think anybody out there is using these
  498.   esoteric types, I didn't bother to support them to that extent.
  499.   Objections, anyone?
  500.  
  501. * "AT number" defines a non-combinable segment at the absolute
  502.   memory location whose segment register value is "number".  This
  503.   form is useful for initializing data in fixed locations, such
  504.   as the 86 interrupt vector (IVECTOR SEGMENT AT 0 followed by
  505.   ORG 4 * INT_NUMBER), or for reading fixed memory locations,
  506.   such as the BIOS variables area (BIOS_DATA SEGMENT AT 040).
  507.  
  508. The combine-type specification can be repeated in subsequent
  509. pieces of a given segment, but if it is, it must be the same in
  510. all pieces.
  511.  
  512. Finally, if no combine-type is ever given for a named segment in
  513. a module, that segment is non-combinable-- no other modules may
  514. define that segment; the code given in the one module constitutes
  515. the entire segment.
  516.  
  517. The last specification available on a SEGMENT line is the class
  518. name, which is identified by being enclosed in single quotes.
  519. Unlike a segment name, which can be used as an instruction
  520. operand an hence cannot conflict with other assembler symbols, a
  521. class name can be assigned without regard to its usage elsewhere
  522. in the program.  It can even be a built-in A86 mnemonic.  In
  523. fact, both the SMALL and LARGE high-level-language models specify
  524. the class name 'CODE' for code segments, and the SMALL model
  525. specifies the class name 'DATA'.
  526.  
  527. If no class name is given for a segment, A86 specifies the null
  528. (zero-length) string as the class name.
  529.                                                           10-11
  530. DATA SEGMENT, STRUC and CODE SEGMENT Directives
  531.  
  532. The DATA SEGMENT and STRUC directives work in .OBJ mode exactly
  533. as they do in .COM mode-- they define a special assembly mode, in
  534. which declarations are made, but no object code is output.
  535. Offsets within DATA segments and structures are absolute, as in
  536. .COM mode.  Assembly resumes as before when an ENDS or CODE
  537. SEGMENT directive is encountered.
  538.  
  539. For MASM compatibility (especially in modules written to link
  540. to Turbo Pascal V4.0 programs), I now recognize the keywords
  541. CODE, DATA, and STACK as ordinary relocatable segment names.  The
  542. ordinary functionality takes effect whenever a SEGMENT directive
  543. is given with CODE, DATA or STACK as the segment name, and with
  544. one or more relocatable parameters (e.g., PUBLIC) given after
  545. SEGMENT.
  546.        
  547.  
  548. The ENDS Directive
  549.  
  550. Syntax:  [seg_name] ENDS
  551.  
  552. The ENDS directive closes out the segment currently being
  553. assembled, and returns assembly to the segment being assembled
  554. before the last SEGMENT directive.  The "seg_name", if given,
  555. must match the name in that last SEGMENT directive.  ENDS allows
  556. you to "nest" segments inside one another.  For example, you can
  557. declare some static data variables that are specific to a certain
  558. section of code at the top of that section:
  559.  
  560.   _DATA SEGMENT BYTE PUBLIC 'DATA'
  561.     VAR1  DB ?
  562.     VAR2  DB ?
  563.   _DATA ENDS
  564.  
  565. These four lines can be inserted inside any other segment being
  566. assembled.  They will cause the two variable allocations to be
  567. tacked onto the segment _DATA; and assembly will then continue in
  568. whatever segment surrounded the four lines.  Observe that the
  569. "nesting" does not occur in the final program; only the
  570. presentation of the source code is nested.
  571.  
  572. If you are not nesting segments inside one another, then the ENDS
  573. directive serves only to lend a clean, "block-structured"
  574. appearance to your source code.  It does not assist A86 in any
  575. particular way; in fact, it consumes a bit more object output
  576. memory (slightly reducing object output capacity) if you have
  577. ENDSs, rather than just starting up new segments with SEGMENT
  578. directives.
  579.  
  580.  
  581. Default Outer SEGMENT
  582.  
  583. Other assemblers outlaw any code outside of a SEGMENT
  584. declaration, forcing you to give a SEGMENT declaration before you
  585. can assemble anything.  A86 lets you assemble just your code; you
  586. don't have to worry about SEGMENTs if you don't want to.
  587.                                                           10-12
  588. If you do provide code outside of all SEGMENT declarations, A86
  589. performs the following steps, to find a reasonable place to put
  590. the code:
  591.  
  592. 1. If there are any segments explicitly declared whose name is or
  593.    ends with "_TEXT", then the first such segment declared is
  594.    used.  It is as if the SEGMENT declaration appeared at the top
  595.    of, rather than within, the program.
  596.  
  597. 2. If there is no such explicit segment, A86 creates a BYTE
  598.    PUBLIC segment of class 'CODE', and proceeds to construct a
  599.    name for the segment.  If there are no RETF instructions in
  600.    the outer segment, the name chosen is "_TEXT", conforming to
  601.    the SMALL model of computation.  If there is a RETF
  602.    instruction, the name chosen is "modulename_TEXT", where
  603.    "modulename" is the name of this module.  Recall that
  604.    "modulename" comes from the NAME directive if there is one;
  605.    from the name of the .OBJ file if there isn't.
  606.  
  607.  
  608. The GROUP Directive
  609.  
  610. Syntax:  group_name GROUP seg_name1, seg_name2, ...
  611.  
  612. The GROUP directive causes A86 to tell LINK that all the listed
  613. segments can fit into a single 64K-byte block of memory, and
  614. instruct LINK to make that fit.  (If they won't fit, LINK will
  615. issue an error message.)  Having declared the group, you can then
  616. use "group_name" as the segment register value that will allow
  617. simultaneous access to all the named segments.  The order of
  618. names given in the list does not necessarily determine the order
  619. the segments will finally appear within the group.
  620.  
  621. The most useful application of the GROUP directive is to allow
  622. you to structure the pieces of a program, all of whose code and
  623. data will fit into a single 64K segment.  You organize the pieces
  624. into SEGMENTs, and declare all the SEGMENTs to be within the same
  625. GROUP.  When the program starts, all segment registers are set to
  626. point to the GROUP, and you never have to worry about segment
  627. registers again in the program.
  628.  
  629. WARNING: If your segments will be GROUPed in the final program,
  630. you should have the appropriate GROUP directive in every module
  631. assembled.  If you don't, then any memory pointers generated will
  632. be relative to the beginning of the individual named segments,
  633. not to the beginning of the whole group.
  634.  
  635. Because of the obscure scenario I described in the Overview
  636. section, Intel does not prohibit more than one GROUP from
  637. containing some of the same segments; so neither does A86.  Any
  638. pointers within a segment will be calculated from the beginning
  639. of the last GROUP that the segment was declared within.  But
  640. again, I have my doubts as to whether LINK will handle this
  641. correctly.
  642.                                                           10-13
  643. The SEG Operator
  644.  
  645. Syntax:  SEG operand
  646.  
  647. The SEG operator is provided for compatibility with other 
  648. assemblers, and with some compilers such as Turbo C.  The operand 
  649. to SEG should be a variable or label that is either undefined, or 
  650. declared within a relocatable segment.  The result of the SEG 
  651. operator is the segment containing the variable or label.  If the 
  652. segment cannot be determined by A86, it will be plugged in by 
  653. LINK. 
  654.  
  655. SEG is legal only when A86 is assembling to an OBJ file.  Since 
  656. segment locations are determined at load time, and since COM 
  657. files have no facility for specifying the location of segment 
  658. references, such references are always disallowed in COM files.
  659.  
  660.  
  661.